Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019
You can build, test, and deploy Node.js apps as part of your Azure Pipelines continuous integration and continuous delivery (CI/CD) system. Learn how to use a pipeline to create a Node.js package with Node Package Manager (npm) and publish a pipeline artifact.
The example pipeline automates the process of building, testing, and packaging a Node.js application, making it ready for further deployment or distribution.
Prerequisites
Product | Requirements |
---|---|
Azure DevOps | - An Azure DevOps project. - An ability to run pipelines on Microsoft-hosted agents. You can either purchase a parallel job or you can request a free tier. - Basic knowledge of YAML and Azure Pipelines. For more information, see Create your first pipeline. - Permissions: - To create a pipeline: you must be in the Contributors group and the group needs to have Create build pipeline permission set to Allow. Members of the Project Administrators group can manage pipelines. - To create service connections: You must have the Administrator or Creator role for service connections. |
GitHub | - A GitHub account. - A GitHub service connection to authorize Azure Pipelines. |
Azure | An Azure subscription. |
Product | Requirements |
---|---|
Azure DevOps | - An Azure DevOps project. - A self-hosted agent. To create one, see Self-hosted agents. - Basic knowledge of YAML and Azure Pipelines. For more information, see Create your first pipeline. - Permissions: - To create a pipeline: you must be in the Contributors group and the group needs to have Create build pipeline permission set to Allow. Members of the Project Administrators group can manage pipelines. - To create service connections: You must have the Administrator or Creator role for service connections. |
GitHub | - A GitHub account. - A GitHub service connection to authorize Azure Pipelines. |
Azure | An Azure subscription. |
Fork the sample code
Fork the sample Express.js server app.
- Go to the js-e2e-express-server repository.
- Select Fork in the upper-right corner of the page.
- Select your GitHub account. By default, the fork is named the same as the parent repository, but you can give it a different name.
Important
During the following procedures, you might be prompted to create a GitHub service connection or redirected to GitHub to sign in, install Azure Pipelines, or authorize Azure Pipelines. Follow the instructions on the screen to complete the process. For more information, see Access to GitHub repositories.
Create your pipeline
- In your Azure DevOps project, select Pipelines > Create Pipeline, then select GitHub as the location of your source code.
- On the Select a repository screen, select your forked sample repository.
- On the Configure your pipeline screen, select Starter pipeline. Azure Pipelines generates a YAML file named azure-pipelines.yml for your pipeline.
- Select the dropdown caret next to Save and run, select Save, then select Save again. The file is saved to your forked GitHub repository.
- On the next screen, select Edit.
Build the package and publish an artifact
Edit the azure-pipelines.yml file as follows.
Replace the file contents with the following code.
trigger: - main pool: vmImage: 'ubuntu-latest' variables: nodeVersion: '18.x' steps: # Install Node.js - task: UseNode@1 inputs: version: $(nodeVersion) displayName: 'Install Node.js' # Install dependencies - script: | npm install displayName: 'Install dependencies' # Build the project - script: | npm run build displayName: 'Build project' # Run tests - script: | npm test displayName: 'Run tests' # Copy project files to artifact staging directory - task: CopyFiles@2 inputs: sourceFolder: '$(Build.SourcesDirectory)' contents: | src/** public/** targetFolder: '$(Build.ArtifactStagingDirectory)' displayName: 'Copy project files' # Publish pipeline artifact - task: PublishPipelineArtifact@1 inputs: artifactName: 'nodejs-app' targetPath: '$(Build.ArtifactStagingDirectory)' displayName: 'Publish pipeline artifact'
In the updated pipeline, you'll:
- Install Node.js: The UseNode@1 task installs the specified Node.js version (18.x).
- Install dependencies: The npm install command installs the required dependencies for the Node.js project.
- Build the project: The npm run build command builds the Node.js project.
- Run Tests: The npm test command runs the project's test suite.
- Copy files: The CopyFiles@2 task copies the necessary project files (for example,
src/**
andpublic/**
) to the artifact staging directory. - Publish pipeline artifact: The PublishPipelineArtifact@1 task publishes the files from the artifact staging directory as a pipeline artifact named nodejs-app.
Run your pipeline
Select Validate and save, then Save, Run, and Run again.
After your pipeline runs, verify that the job ran successfully and that you see a published artifact.
Congratulations, you successfully created and ran a pipeline that built and tested a Node.js package. To extend your pipeline, you can:
- Deploy to a cloud platform with a service like Azure App Service
- Publish as a NPM package
- Deploy a static hosting service like Azure Static Web Apps
- Containerize and deploy Azure Kubernetes Service or other container orchestration platforms